added: [M3-6989] - aria-describedby to TextField with helper text
#11351
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
abailly-akamai
added
the
Accessibility
abailly-akamai
commented
Dec 3, 2024
| @@ -113,7 +113,8 @@ interface InputToolTipProps { | |||
| tooltipWidth?: number; | |||
| } | |||
|
|
|||
| interface TextFieldPropsOverrides extends StandardTextFieldProps { | |||
| interface TextFieldPropsOverrides | |||
| extends Omit<StandardTextFieldProps, 'label'> { | |||
There was a problem hiding this comment.
This helps TS in general not having to compare overridden types. While in this case this is just a string and this likely has no impact, it's just good practice.
| (label | ||
| ? convertToKebabCase(label) | ||
| : // label could still be an empty string | ||
| fallbackId); |
There was a problem hiding this comment.
always making sure we have an ID
abailly-akamai
changed the title
aria-describedby to TextField with helper textaria-describedby to TextField with helper text
abailly-akamai
changed the title
aria-describedby to TextField with helper textaria-describedby to TextField with helper text
abailly-akamai
requested review from
dwiley-akamai and
hkhalil-akamai
and removed request for
a team
|
Coverage Report: ✅ |
There was a problem hiding this comment.
We should make the same change when displaying error messages. VoiceOver currently isn't able to pick them up:
There was a problem hiding this comment.
@hkhalil-akamai That's fair, this one has a role="alert" attribute which is very much meant for this type of behavior (aka, a validation error injected into the DOM) but could indeed use more context.
see commit 95a8d3e which follows this recommended pattern
abailly-akamai
force-pushed
the
M3-6989-helper-text-accessibility
branch
from
95a8d3e to
fd53887
Compare
dwiley-akamai
approved these changes
Dec 4, 2024
Cloud Manager UI test results🔺 3 failing tests on test run #8 ↗︎
Details
TroubleshootingUse this command to re-run the failing tests: yarn cy:run -s "cypress/e2e/core/linodes/rebuild-linode.spec.ts,cypress/e2e/core/linodes/rebuild-linode.spec.ts,cypress/e2e/core/linodes/rebuild-linode.spec.ts" |
|||||||||||||||||||||||
hkhalil-akamai
approved these changes
Dec 5, 2024
Cloud Manager E2E
|
||||||||||||||||||||||||||||
| Project |
Cloud Manager E2E
|
| Branch Review |
develop
|
| Run status |
|
| Run duration | 28m 27s |
| Commit |
|
| Committer | Alban Bailly |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
0
|
Flaky
|
2
|
Pending
|
2
|
Skipped
|
0
|
Passing
|
466
|
| View all changes introduced in this branch ↗︎ | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description 📝
Tiny PR to add better accessibility to the
Textfieldvia itshelperTextprop.On screen, it is trivial for a user to see a helper test associated with a field, but this is not necessarily true for someone using a screen reader, since the helper text is a plain paragraph floating under the input, and isn't associated with its relevant interactive element.
Changes 🔄
Preview 📷
How to test 🧪
Prerequisites
Verification steps
Textfield&HelperTextrelationshipAs an Author, before moving this PR from Draft to Open, I confirmed ✅